<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV="Content-Type" Content="text/html; charset=Windows-1252">
<TITLE>HH_WINTYPE structure</TITLE>
<style>@import url(coUA.css);</style>
<link disabled rel="stylesheet" href="htmlhelp.css">
</head>

<BODY>

<H1>HH_WINTYPE structure</H1>

Use this structure to specify or modify the attributes of a <a href="ov_about_help_window_types.htm">window type</a>. 

<p>Window types can be defined by an author in a project (.hhp) file, or they can be defined programmatically using the HTML Help API.</p>

<P>When a <B>HH_WINTYPE</B> structure is passed to HtmlHelp() using the <B>HH_SET_WIN_TYPE</B> command, the HTML Help API makes a private copy of the contents of the structure. The help developer is therefore responsible for freeing memory used by the <B>HH_WINTYPE</B> structure or character arrays within it. The help developer can free memory after calling <B>HH_SET_WIN_TYPE</B>.</P>

<h2>Used by</h2>
<ul>
<li><a href="cmd_hh_set_win_type.htm">HH_SET_WIN_TYPE</a> 
<li><a href="cmd_hh_get_win_type.htm">HH_GET_WIN_TYPE</a>
</li>
</ul>

<h2>HH_WINTYPE structure syntax</h2>

<p><PRE><code>
typedef struct tagHH_WINTYPE
<BR>{
<BR>     int           cbStruct;        
<BR>     BOOL          fUniCodeStrings; 
<BR>     LPCTSTR       pszType;         
<BR>     DWORD         fsValidMembers;  
<BR>     DWORD         fsWinProperties; 
<BR>     LPCTSTR       pszCaption;     
<BR>     DWORD         dwStyles;       
<BR>     DWORD         dwExStyles;     
<BR>     RECT          rcWindowPos;    
<BR>     int           nShowState;     
<BR>     HWND          hwndHelp;     
<BR>     HWND          hwndCaller;
<BR>     HWND          hwndToolBar;      
<BR>     HWND          hwndNavigation;   
<BR>     HWND          hwndHTML;         
<BR>     int           iNavWidth;        
<BR>     RECT          rcHTML;           
<BR>     LPCTSTR       pszToc;     
<BR>     LPCTSTR       pszIndex;   
<BR>     LPCTSTR       pszFile;    
<BR>     LPCTSTR       pszHome;    
<BR>     DWORD         fsToolBarFlags; 
<BR>     BOOL          fNotExpanded; 
<BR>     int           curNavType; 
<BR>     int           idNotify; 
<BR>     LPCTSTR       pszJump1;
<BR>     LPCTSTR       pszJump2;
<BR>     LPCTSTR       pszUrlJump1;
<BR>     LPCTSTR       pszUrlJump2;  
<BR>} HH_WINTYPE;
<BR>
</PRE></code></p>
<br>

<!--------------------Member definitions--------------------------->
<!----------------------------------------------------------------->
<table border=1 cellpadding=3 cellspacing=0 width=100%>
<TR>
<TH>
<b>Member</b>
</TH>
<TH>
<b>Description</b>
</TH>
</TR>

<TR>
<TD>
<i>cbStruct</i>
</TD>
<TD>
Specifies the size of the structure. This value must always be filled in before passing the structure to HtmlHelp().
</TD>
</TR>

<TR>
<TD>
<i>fUniCodeStrings</i>
</TD>
<TD>
Specifies whether the strings used in this structure are UNICODE.

</TD>
</TR>
<TR>
<TD>
<i>pszType</i>
</TD>
<TD>
A null-terminated string that specifies the name of the window type.
</TD>
</TR>

<TR>
<TD>
<a href="str_hh_wintype_fsvalidmembers.htm"><i>fsValidMembers</i></a>
</TD>
<TD >
Specifies which members in the structure are valid.
</TD>
</TR>

<TR>
<TD>
<a href="str_hh_wintype_fswinproperties.htm"><i>fsWinProperties</i></a>
</TD>
<TD>
Specifies the properties of the window, such as whether it is the standard HTML Help Viewer or whether it includes a <b>Search</b> tab.
</li>
</ul>
</TD>
</TR>

<TR>
<TD>
<i>pszCaption</i>
</TD>
<TD>
A null-terminated string that specifies the caption to display in the title bar of the window.
</TD>
</TR>

<TR>
<TD>
<i>dwStyles</i>
</TD>
<TD>
Specifies the styles used to create the window. These styles can be ignored, combined with extended styles, or used exclusively depending on the value of the <i>fsValidMembers</i> and <i>fsWinProperties</i> parameters.
</TD>
</TR>

<TR>
<TD>
<i>dwExStyles</i>
</TD>
<TD>
Specifies the extended styles used to create the window. These styles can be ignored, combined with default styles, or used exclusively depending on the value of the <i>fsValidMembers</i> and <i>fsWinProperties</i> parameters.
</TD>
</TR>

<TR>
<TD>
<i>rcWindowPos</i>
</TD>
<TD>
Specifies the coordinates of the window in pixels. The values are read in the following order:
<br><code>
rcWindowPos = {left, top, right, bottom};
</code>
</TD>
</TR>

<TR>
<TD>
<i>nShowState</i>
</TD>
<TD>
Specifies the initial display state of the window. Valid values are the same as those for the Win32 API <b>ShowWindow</b> function.
</TD>
</TR>

<TR>
<TD>
<i>hwndHelp</i>
</TD>
<TD>
Specifies the handle of the window if the window has been created.
</TD>
</TR>

<TR>
<TD>
<i>hwndCaller</i>
</TD>
<TD>
Specifies the window that will receive HTML Help notification messages. <a href="ov_about_notification_messages.htm">Notification messages</a> are sent via Windows <b>WM_NOTIFY</b> messages.
</TD>
</TR>

<TR>
<TD>
<i>idNotify</i>
</TD>
<TD>
Specifies a non-zero ID for enabling HTML Help notification messages. This ID is passed as the <i>wParam</i> value of Windows <b>WM_NOTIFY</b> messages.
</TD>
</TR>


<!--TR>
<TD>
<i>paInfoTypes</i>
</TD>
<TD>
<b>This member is not currently supported and must be set to NULL.</b>
</TD>
</TR-->

<!--TR>
<TD>
<i>rcMinSize</i>
</TD>
<TD>
Specifies the minimize size the window may be resized to by the user.
<p><b>This parameter is not currently supported.</b></p>
</TD>
</TR-->
</table>

<h3>Members specific to the <a href="wintypes_viewer.htm">Help Viewer</a></h3>
<br>
<table border=1 cellpadding=3 cellspacing=0 width=100%>
<TR>
<TH>
<b>Member</b>
</TH>
<TH>
<b>Description</b>
</TH>
</TR>

<TR>
<TD>
<i>hwndToolBar</i>
</TD>
<TD>
Specifies the handle of the toolbar.
</TD>
</TR>

<TR>
<TD>
<i>hwndNavigation</i>
</TD>
<TD>
Specifies the handle of the Navigation pane.
</TD>
</TR>

<TR>
<TD>
<i>hwndHTML</i>
</TD>
<TD>
Specifies the handle of the Topic pane, which hosts Shdocvw.dll.
</TD>
</TR>

<TR ALIGN=LEFT VALIGN=TOP>
<TD>
<i>iNavWidth</i>
</TD>
<TD>
Specifies the width of the Navigation pane when the Help Viewer is expanded.
</TD>
</TR>

<TR>
<TD>
<i>rcHTML</i>
</TD>
<TD>
Specifies the coordinates of the Topic pane. 
</TD>
</TR>
<TR>
<TD>
<i>pszToc</i>
</TD>
<TD>
Specifies the contents (.hhc) file to display in the Navigation pane.
</TD>
</TR>
<TR>
<TD>
<i>pszIndex</i>
</TD>
<TD>
Specifies the index (.hhk) file to display in the Navigation pane.
</TD>
</TR>
<TR>
<TD>
<i>pszFile</i>
</TD>
<TD>
Specifies the default HTML file to display in the Topic pane.
</TD>
</TR>

<TR>
<TD>
<i>pszHome</i>
</TD>
<TD>
Specifies the file or URL to display in the Topic pane when the <b>Home</b> button is clicked.

</TD>
</TR>
<TR>
<TD>
<a href=JavaScript:fstoolbarflags.Click()><i>fsToolBarFlags</i></a>

<OBJECT id=fstoolbarflags type="application/x-oleobject"
        classid="clsid:adb880a6-d8ff-11cf-9377-00aa003b7a11"

>
    <PARAM name="Command" value="Related Topics">
    <PARAM name="Item1" value="fsToolBarFlags;str_hh_wintype_fstoolbarflags.htm">
</OBJECT>

</TD>
<TD>
Specifies which buttons to include on the toolbar.
</TD>
</TR>

<TR>
<TD>
<i>fNotExpanded</i>
</TD>
<TD>
Specifies that the Help Viewer open with the Navigation pane closed.
</TD>
</TR>

<TR>
<TD>
<a href="str_hh_wintype_curnavtype.htm"><i>curNavType</i></a>
</TD>
<TD>
Specifies the default tab to display on the Navigation pane.
</TD>
</TR>




<TR>
<TD>
<i>pszJump1</i>
</TD>
<TD>
Specifies the text to display underneath the <b>Jump1</b> button.
</TD>
</TR>

<TR>
<TD>
<i>pszJump2</i>
</TD>
<TD>
Specifies the text to display underneath the <b>Jump2</b> button.
</TD>
</TR>
<TR>
<TD>
<i>pszUrlJump1</i>
</TD>
<TD>
Specifies the URL to jump to when the <b>Jump1</b> button is clicked.
</TD>
</TR>

<TR>
<TD>
<i>pszUrlJump2</i>
</TD>
<TD>
Specifies the URL to jump to when the <b>Jump2</b> button is clicked.
</TD>
</TR>


</TABLE>

<br>
<!---insert See Also's-->
<OBJECT 
         id=parameter_values 
         type="application/x-oleobject"
        classid="clsid:adb880a6-d8ff-11cf-9377-00aa003b7a11"

>
    <PARAM name="Command" value="ALink, MENU">
    <PARAM name="Item1" value="">
    <PARAM name="Item2" value="fsWinProperties">
    <PARAM name="Item3" value="fsToolBarFlags">
    <PARAM name="Item4" value="CurNavType">
    <PARAM name="Item5" value="fsValidMembers">
</OBJECT>

<h2><a href=JavaScript:parameter_values.Click()>See Also</a></h2>

<br>
<table border="0" cellpadding="0" cellspacing="4">
<tr>
<td valign="top"><a href="ov_about_htmlhelp_structures.htm"><img src="home.gif" width=20 height=18 alt="link to overview topic" border="0"></a>
</td>
<td><a href="ov_about_htmlhelp_structures.htm">About structures</A>
</td>
</tr>
<tr>
<td>&nbsp;
</td>
</tr>
</table>

<!---insert keywords-->

</BODY>
</HTML>
